Skip to content

feat: add sequential batch support #5762

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 14 commits into from
May 20, 2025
Merged

feat: add sequential batch support #5762

merged 14 commits into from
May 20, 2025

Conversation

@vinistevam
Copy link
Contributor

@vinistevam vinistevam commented May 6, 2025 •
edited
Loading

Explanation

The TransactionController currently lacks support for sequential batch transactions, which are required for the stablecoin lending feature. Specifically, there is no mechanism to execute multiple transactions (e.g., approval + token deposit) sequentially while ensuring confirmation for each transaction. This limitation prevents efficient batch processing to support new features.

What solution do these changes offer?
The SequentialPublishBatchHook introduces a default mechanism for handling batch transactions when no custom publishBatchHook is provided. It ensures transactions are published sequentially, waiting for confirmation before proceeding to the next. If any transaction fails to publish or confirm, the batch process halts and throws an error.

Key Features:

  • Sequential Execution: Publishes transactions one at a time and waits for confirmation.
  • Error Handling: Halts the batch if any transaction fails to publish or confirm.
  • Polling for Confirmation: Retries confirmation checks up to a maximum number of attempts.

References

Fixes https://github.com/MetaMask/MetaMask-planning/issues/4695

Changelog

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've communicated my changes to consumers by updating changelogs for packages I've changed, highlighting breaking changes as necessary
  • I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

@vinistevam vinistevam force-pushed the feat/add-sequential-batch-hook branch from 0e732db to 8b9e6f7 Compare May 6, 2025 08:17
@vinistevam
Copy link
Contributor Author

@metamaskbot publish-preview

@github-actions
Copy link
Contributor

github-actions bot commented May 6, 2025

Preview builds have been published. See these instructions for more information about preview builds.

Expand for full list of packages and versions. 
{
  "@metamask-previews/accounts-controller": "27.0.0-preview-8b9e6f7b",
  "@metamask-previews/address-book-controller": "6.0.3-preview-8b9e6f7b",
  "@metamask-previews/announcement-controller": "7.0.3-preview-8b9e6f7b",
  "@metamask-previews/app-metadata-controller": "1.0.0-preview-8b9e6f7b",
  "@metamask-previews/approval-controller": "7.1.3-preview-8b9e6f7b",
  "@metamask-previews/assets-controllers": "60.0.0-preview-8b9e6f7b",
  "@metamask-previews/base-controller": "8.0.1-preview-8b9e6f7b",
  "@metamask-previews/bridge-controller": "20.0.0-preview-8b9e6f7b",
  "@metamask-previews/bridge-status-controller": "17.0.0-preview-8b9e6f7b",
  "@metamask-previews/build-utils": "3.0.3-preview-8b9e6f7b",
  "@metamask-previews/chain-agnostic-permission": "0.5.0-preview-8b9e6f7b",
  "@metamask-previews/composable-controller": "11.0.0-preview-8b9e6f7b",
  "@metamask-previews/controller-utils": "11.7.0-preview-8b9e6f7b",
  "@metamask-previews/delegation-controller": "0.1.0-preview-8b9e6f7b",
  "@metamask-previews/earn-controller": "0.12.0-preview-8b9e6f7b",
  "@metamask-previews/eip1193-permission-middleware": "0.1.0-preview-8b9e6f7b",
  "@metamask-previews/ens-controller": "16.0.0-preview-8b9e6f7b",
  "@metamask-previews/eth-json-rpc-provider": "4.1.8-preview-8b9e6f7b",
  "@metamask-previews/gas-fee-controller": "23.0.0-preview-8b9e6f7b",
  "@metamask-previews/json-rpc-engine": "10.0.3-preview-8b9e6f7b",
  "@metamask-previews/json-rpc-middleware-stream": "8.0.7-preview-8b9e6f7b",
  "@metamask-previews/keyring-controller": "21.0.5-preview-8b9e6f7b",
  "@metamask-previews/logging-controller": "6.0.4-preview-8b9e6f7b",
  "@metamask-previews/message-manager": "12.0.1-preview-8b9e6f7b",
  "@metamask-previews/multichain": "4.0.0-preview-8b9e6f7b",
  "@metamask-previews/multichain-api-middleware": "0.2.0-preview-8b9e6f7b",
  "@metamask-previews/multichain-network-controller": "0.5.1-preview-8b9e6f7b",
  "@metamask-previews/multichain-transactions-controller": "0.9.0-preview-8b9e6f7b",
  "@metamask-previews/name-controller": "8.0.3-preview-8b9e6f7b",
  "@metamask-previews/network-controller": "23.3.0-preview-8b9e6f7b",
  "@metamask-previews/notification-services-controller": "6.0.0-preview-8b9e6f7b",
  "@metamask-previews/permission-controller": "11.0.6-preview-8b9e6f7b",
  "@metamask-previews/permission-log-controller": "3.0.3-preview-8b9e6f7b",
  "@metamask-previews/phishing-controller": "12.5.0-preview-8b9e6f7b",
  "@metamask-previews/polling-controller": "13.0.0-preview-8b9e6f7b",
  "@metamask-previews/preferences-controller": "17.0.0-preview-8b9e6f7b",
  "@metamask-previews/profile-sync-controller": "12.0.0-preview-8b9e6f7b",
  "@metamask-previews/queued-request-controller": "10.0.0-preview-8b9e6f7b",
  "@metamask-previews/rate-limit-controller": "6.0.3-preview-8b9e6f7b",
  "@metamask-previews/remote-feature-flag-controller": "1.6.0-preview-8b9e6f7b",
  "@metamask-previews/sample-controllers": "0.1.0-preview-8b9e6f7b",
  "@metamask-previews/selected-network-controller": "22.0.0-preview-8b9e6f7b",
  "@metamask-previews/signature-controller": "27.1.0-preview-8b9e6f7b",
  "@metamask-previews/token-search-discovery-controller": "3.1.0-preview-8b9e6f7b",
  "@metamask-previews/transaction-controller": "54.4.0-preview-8b9e6f7b",
  "@metamask-previews/user-operation-controller": "33.0.0-preview-8b9e6f7b"
}

@vinistevam vinistevam marked this pull request as ready for review May 8, 2025 13:23
@vinistevam vinistevam requested review from a team as code owners May 8, 2025 13:23
matthewwalsh0
matthewwalsh0 requested changes May 8, 2025
View reviewed changes
matthewwalsh0
matthewwalsh0 requested changes May 19, 2025
View reviewed changes
@vinistevam vinistevam enabled auto-merge (squash) May 20, 2025 12:44
@vinistevam vinistevam merged commit dbe5097 into main May 20, 2025
202 checks passed
@vinistevam vinistevam deleted the feat/add-sequential-batch-hook branch May 20, 2025 12:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pedronfigueiredo pedronfigueiredo pedronfigueiredo approved these changes

@matthewwalsh0 matthewwalsh0 matthewwalsh0 approved these changes

Assignees

No one assigned

Labels

team-confirmations

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@vinistevam @pedronfigueiredo @matthewwalsh0